/*
 * RMTransactionManager.java    ver   30/nov/2009
 *
 * Copyright (c) 2009 mentalsmash.org
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * The use of the Apache License does not indicate that this project is
 * affiliated with the Apache Software Foundation.
 */
package org.mentalsmash.tazio.transactions.management.rm;

import org.mentalsmash.tazio.commons.identifiers.OID;
import org.mentalsmash.tazio.transactions.log.TransactionsLog;
import org.mentalsmash.tazio.transactions.management.SystemTransactionManager;
import org.mentalsmash.tazio.transactions.management.TazioTransaction;
import org.mentalsmash.tazio.transactions.management.ValidationAgent;

/**
 * @version ver 30/nov/2009
 * @author Andrea Reale <andrea.reale@gmail.com>
 * 
 */
public interface RMTransactionManager {

    /**
     * Enqueues a Transaction to have it committed sooner or later
     * 
     * @param tx
     *            the transaction to commit eventually
     * @return true if the transaction was accepted, otherwise false
     */
    boolean offerTransactionForCommit(TazioTransaction tx);

    /**
     * Returns the unique name of this ReplicaManager instance
     * 
     * @return the unique name of this ReplicaManager instance
     */
    OID getManagerName();

    /**
     * Retrieves an instance of the validation agent used by the
     * {@link SystemTransactionManager}
     * 
     * @return an instance of the validation agent used by the
     *         {@link SystemTransactionManager}
     */
    ValidationAgent getValidationAgent();

    /**
     * Returns the instance of {@link TransactionLog} which contains the
     * complete history of active and inactive transactions managed by this
     * instance of <tt>TransactionManager</tt>
     * 
     * @return
     */
    TransactionsLog getTransactionsLog();

    /**
     * @return
     */
    long getSeqNoCtr();

    long incrementAndGetSeqNoCtr();

    void lockCounter();

    void unlockCounter();
}
